<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>sipML5: tsip_session Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="sipml-45x51.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">sipML5
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">World&#39;s first HTML5 SIP Client</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">tsip_session Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a href="classtsip__session-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a52ce7b54326d204a3ebfd5a79ea23d6f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a52ce7b54326d204a3ebfd5a79ea23d6f">tsip_session</a> (<a class="el" href="classtsip__stack.html">tsip_stack</a> o_stack)</td></tr>
<tr class="memitem:a80b77bc8b2094ca9a496b94a6e2c2c14"><td class="memItemLeft" align="right" valign="top">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a80b77bc8b2094ca9a496b94a6e2c2c14">SetToStr</a> (String s_to)</td></tr>
<tr class="memitem:a5a29f3be9ed96837960967f0033ac035"><td class="memItemLeft" align="right" valign="top">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a5a29f3be9ed96837960967f0033ac035">SetExpires</a> (int i_expires)</td></tr>
<tr class="memitem:a1e0f6d1b18d4b14ce1cc858c25d0b076"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a1e0f6d1b18d4b14ce1cc858c25d0b076">is_connected</a> ()</td></tr>
<tr class="memitem:a496a366773048acf750e25ca337ab36b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a496a366773048acf750e25ca337ab36b">get_id</a> ()</td></tr>
<tr class="memitem:ae58e6e54a32cfe100035ff0784e704d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#ae58e6e54a32cfe100035ff0784e704d7">get_stack</a> ()</td></tr>
<tr class="memitem:a03c210599bb87950a56f3c82c808cfcc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a03c210599bb87950a56f3c82c808cfcc">set</a> ()</td></tr>
<tr class="memitem:adb956d8b658d6606931a0755109f1079"><td class="memItemLeft" align="right" valign="top">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#adb956d8b658d6606931a0755109f1079">SetCaps</a> (String s_name, String s_value)</td></tr>
<tr class="memitem:a827acf39b9d9cbb6a057e23af7b2c402"><td class="memItemLeft" align="right" valign="top">Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a827acf39b9d9cbb6a057e23af7b2c402">SetHeader</a> (String s_name, String s_value)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a3ea6eb6c5ac775ac4ac40a5d2404de6e"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtsip__session.html#a3ea6eb6c5ac775ac4ac40a5d2404de6e">__i_expires_default</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base SIP session </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a52ce7b54326d204a3ebfd5a79ea23d6f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classtsip__session.html#a52ce7b54326d204a3ebfd5a79ea23d6f">tsip_session::tsip_session</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classtsip__stack.html">tsip_stack</a>&#160;</td>
          <td class="paramname"><em>o_stack</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">o_stack</td><td>SIP stack used to create the session </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a496a366773048acf750e25ca337ab36b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classtsip__session.html#a496a366773048acf750e25ca337ab36b">tsip_session::get_id</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets session id </p>
<dl class="section return"><dt>Returns:</dt><dd>session id </dd></dl>

</div>
</div>
<a class="anchor" id="ae58e6e54a32cfe100035ff0784e704d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classtsip__session.html#ae58e6e54a32cfe100035ff0784e704d7">tsip_session::get_stack</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets SIP stack used to create this session </p>

</div>
</div>
<a class="anchor" id="a1e0f6d1b18d4b14ce1cc858c25d0b076"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classtsip__session.html#a1e0f6d1b18d4b14ce1cc858c25d0b076">tsip_session::is_connected</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Checks whether the session is connected or not </p>
<dl class="section return"><dt>Returns:</dt><dd>true if connected and false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="a03c210599bb87950a56f3c82c808cfcc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classtsip__session.html#a03c210599bb87950a56f3c82c808cfcc">tsip_session::set</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets parameters </p>

</div>
</div>
<a class="anchor" id="adb956d8b658d6606931a0755109f1079"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Object <a class="el" href="classtsip__session.html#adb956d8b658d6606931a0755109f1079">tsip_session::SetCaps</a> </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>s_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>s_value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Adds session capabilities </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">s_name</td><td>Capiblity name </td></tr>
    <tr><td class="paramname">s_value</td><td>Capability value (optional) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>Parameter object</dd></dl>
<div class="fragment"><pre class="fragment">o_session.set(
    <a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#adb956d8b658d6606931a0755109f1079">SetCaps</a>(<span class="stringliteral">&quot;+g.oma.sip-im&quot;</span>),
    <a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#adb956d8b658d6606931a0755109f1079">SetCaps</a>(<span class="stringliteral">&quot;+audio&quot;</span>),
    <a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#adb956d8b658d6606931a0755109f1079">SetCaps</a>(<span class="stringliteral">&quot;language&quot;</span>, <span class="stringliteral">&quot;\&quot;en,fr\&quot;&quot;</span>)
);
</pre></div> 
</div>
</div>
<a class="anchor" id="a5a29f3be9ed96837960967f0033ac035"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Object <a class="el" href="classtsip__session.html#a5a29f3be9ed96837960967f0033ac035">tsip_session::SetExpires</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>i_expires</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets expires timeout </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">i_expires</td><td>Session expires timeout in seconds </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>Parameter object</dd></dl>
<div class="fragment"><pre class="fragment">o_session.set(<a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#a5a29f3be9ed96837960967f0033ac035">SetExpires</a>(1800));
</pre></div> 
</div>
</div>
<a class="anchor" id="a827acf39b9d9cbb6a057e23af7b2c402"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Object <a class="el" href="classtsip__session.html#a827acf39b9d9cbb6a057e23af7b2c402">tsip_session::SetHeader</a> </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>s_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>s_value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Adds session-level header </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">s_name</td><td>SIP header name </td></tr>
    <tr><td class="paramname">s_value</td><td>Header value </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>Parameter object</dd></dl>
<div class="fragment"><pre class="fragment">o_session.set(
    <a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#a827acf39b9d9cbb6a057e23af7b2c402">SetHeader</a>(<span class="stringliteral">&quot;P-Preferred-Identity&quot;</span>, <span class="stringliteral">&quot;&lt;sip:alice@doubango.org&gt;&quot;</span>),
    <a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#a827acf39b9d9cbb6a057e23af7b2c402">SetHeader</a>(<span class="stringliteral">&quot;Date&quot;</span>, <span class="stringliteral">&quot;Wed, 28 Apr 2010 23:42:50 GMT&quot;</span>)
);
</pre></div> 
</div>
</div>
<a class="anchor" id="a80b77bc8b2094ca9a496b94a6e2c2c14"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Object <a class="el" href="classtsip__session.html#a80b77bc8b2094ca9a496b94a6e2c2c14">tsip_session::SetToStr</a> </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>s_to</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets destination uri </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">s_to</td><td>Destination Uri </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>Parameter object</dd></dl>
<div class="fragment"><pre class="fragment">o_session.set(
    <a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#a80b77bc8b2094ca9a496b94a6e2c2c14">SetToStr</a>(<span class="stringliteral">&quot;sip:alice@doubango.org&quot;</span>)
);
<span class="comment">// or</span>
o_session.set(
    <a class="code" href="classtsip__session.html">tsip_session</a>.prototype.<a class="code" href="classtsip__session.html#a80b77bc8b2094ca9a496b94a6e2c2c14">SetToStr</a>(<span class="stringliteral">&quot;alice&quot;</span>)
); <span class="comment">// the SIP Uri will be built using domain name (realm)</span>
</pre></div> 
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a3ea6eb6c5ac775ac4ac40a5d2404de6e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classtsip__session.html#a3ea6eb6c5ac775ac4ac40a5d2404de6e">tsip_session::__i_expires_default</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default SIP session expires timeout </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/tinySIP/src/tsip_session.cxx</li>
</ul>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Wed May 16 2012 23:47:02 for sipML5 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>

</body>
</html>
